A továbbiakban a műszaki dokumentációval kapcsolatos legfontosabb ismereteket összegezzük (lásd Fóris & Faludi, 2017).

A műszaki területen dolgozó szakemberek gondolataikat, elképzeléseiket műszaki dokumentációban rögzítik, amelynek két fő része a szöveges és a rajzdokumentáció. Az 1. ábra mutatja, hogy akár egyetlen ábra is képes egyszerre többféle információ közlésére. Az alkotóelemeken túl az elvégzendő feladatokat is láthatjuk az ábrán – a tömítés alkalmazása, olaj és egyéb kenőanyagok felvitele, szerelés, megszorítás nyomatéka stb. vonatkozásában.

A szöveges dokumentáció tartalmazza a szükséges engedélyeket, műszaki leírást, szakmai számításokat, építési, üzemeltetési, javítási utasításokat. A műszaki dokumentáció elkészítése a gyártó kötelezettsége, illetve a forgalmazó feladata (lásd 2012. évi LXXXVIII. törvény – a termékek piacfelügyeletéről).

Magyar nyelvű műszaki szakszövegek kognitív szövegtipológiai vizsgálata során Csontos megállapította, hogy a műszaki szakszövegek nem alkotnak homogén kategóriát, nem tekinthetők egyetlen szövegtípusnak, hanem diskurzustartományként értelmezhetők (Csontos, 2019). „A szövegek közös jegye a figyelem előterében, központjában álló (a) műszaki tárgy, illetve (b) a műszaki tárgy-ra (annak összetételére és/vagy működésére) irányuló tudás megosztása” (Csontos, 2019, 155–156). A műszaki szövegek eltérő módon tehetik közzé a tárgy-at és a hozzá kapcsolódó tudás-t.

Kifejezetten szakszövegírók és műszaki szerkesztők számára dolgozta ki szövegtipológiáját Göpferich (Göpferich, 1998). (A műszaki és természettudományi szakszövegek e lehetséges osztályozását a 6. ábrán mutatjuk be a 3.2.1.1. alfejezetben.) Göpferich kommunikatív funkciójuk alapján ötféle, az információ közlésének módja alapján pedig nyolcféle elsődleges szövegfajtát különböztet meg.

A kommunikatív funkció alapján beszélhetünk jogi-szabványosító; fejlődésorientált aktualizáló; didaktikus-tanító; továbbá ismeret-összefoglaló szövegekről. A didaktikus-tanító szövegek tovább osztályozhatók elméleti tudást közvetítő, illetve ember és technika interakcióját célzó (gyakorlati célú) szövegekre.

Az információ közlésének módja alapján a fejlődésorientált aktualizáló szövegek lehetnek tényközlők vagy publicisztikailag feldolgozottak; az elméleti tudást közvetítő szövegek pedig mnemotechnikai módszerekkel felépítettek vagy érdeklődést felkeltők. Tényközlő szöveg lehet jelentés vagy beszámoló, szakfolyóiratcikk, monográfia, disszertáció (1), publicisztikailag feldolgozott például egy szakfolyóiratcikk (2). A mnemotechnikai módszerekkel felépített szövegek közé sorolhatjuk a tankönyveket (3), az érdeklődést felkeltők közé pedig például a népszerű tudományos cikkeket, szakkönyveket, termékinformációkat (4). Ember és technika interakcióját célzó szöveg lehet például egy útmutató vagy gyakorlati bemutató (5).

Az ismeret-összefoglaló szövegek is osztályozhatók az információ közlésének módja szerint, így beszélhetünk enciklopédikus és nem teljes mondatokat tartalmazó szövegekről. Enciklopédikus szövegeket enciklopédiákban vagy lexikonokban (6) találhatunk, a nem teljes mondatokat tartalmazó szövegek vonatkozásában pedig képletgyűjteményekre, alkatrészlistákra vagy katalógusokra (7) gondolhatunk.

A jogi-szabványosító szövegek szabvány, specifikáció vagy szabadalom (8) formájában jöhetnek létre.

Műszaki dokumentáció – a fenti felsorolás alapján – a műszaki és természettudományos szövegek szinte bármelyik formájában létrejöhet. A műszaki dokumentációk különböző dokumentumegységekből állhatnak, így alighanem az is előfordul, hogy az egyes egységek különböző kategóriákhoz sorolhatók. Például a kezelési útmutatók egyaránt tartalmazhatnak útmutató jellegű és specifikációs részeket.

A gyakorlatban a műszaki dokumentációkat megkülönböztethetjük alkalmazási területük és a célközönség – illetve a tárgy és a hozzá kapcsolódó tudás közzétételének módja – alapján. Vagyis aszerint, hogy a vállalat belső vagy külső kommunikációját szolgálják-e, illetve azon belül pontosabban milyen cél(személy)t. A vállalati kommunikációt külső és belső kommunikációra osztják fel a szakirodalomban (lásd Borgulyáné, 2017). A külső kommunikáció a szervezet tagjai és külső célcsoportok tagjai között, a belső kommunikáció a szervezet tagjai között folyik. A szervezet működése során létrehozott dokumentáció tárolásáról és megőrzéséről is a szervezetnek kell gondoskodnia. Itt nem mutatjuk be részletesen a műszaki dokumentáció minden lehetséges típusát, csak két prototipikus formáját tekintjük át röviden.

A belső kommunikáció műszaki dokumentációja esetében beszélhetünk gyártási (szervizelési) dokumentációról vagy eladáshoz szükséges dokumentációról (sales guide) stb. A gyártási dokumentáció olyan műszaki okiratok (rajzok, jegyzékek, előírások stb.) gyűjteménye, amely minden szükséges és elégséges információt hordoz egy adott termék elkészítéséhez. A legtöbb esetben műszaki rajzot is tartalmaz, amely szintén komolyan szabályozott; a rá vonatkozó ismereteket, alapelveket az ICS (International Classification for Standards) szerinti 01.100-as szabványcsalád rögzíti. A rajzdokumentáció tartalmazza a gyártandó termék ábráit, amelyek alapján értelmezni lehet a kialakítandó formákat. A rajzok fajtái szakmánként különbözőek lehetnek (például alap- és homlokzati rajzok, térképészeti rajzok, villamos- vagy géprajz). A műszaki rajzokon szöveges információk is elhelyezhetők; ezek elhelyezésének módját, méreteit, a vonalvastagságot, a betűk vagy szavak közötti távolságot az MSZ EN ISO 3098 szabványcsalád írja elő.

A kifelé irányuló (külső) műszaki dokumentáció legfontosabb eleme a felhasználói dokumentáció (használati utasítás, használati útmutató, kezelési útmutató stb. – a különböző elnevezéseket lásd Csontos tanulmányában: Csontos, 2019). A felhasználói dokumentáció célnyelven való elérhetővé tételére a legtöbb esetben szintén jogszabály kötelezi a forgalmazót. A jogszabály azt is rögzíti, hogy „a használati és kezelési útmutatónak közérthetőnek és egyértelműnek kell lennie, valamint tartalmaznia kell mindazt az információt, amelyet a gyártó által csatolt idegen nyelvű használati és kezelési útmutató tartalmaz” (2012. évi LXXXVIII. törvény 11. § (5)).

A felhasználói dokumentáció célja, hogy a felhasználó számára elégséges információt adjon a berendezés elhelyezési és üzemeltetési feltételeiről, bemutassa a termék alapvető funkcionális kezelőszerveit, rendeltetését, a kezeléssel, rendeltetésszerű használattal kapcsolatos tudnivalókat. Ismerteti az előírásos műszaki állapot fenntartásához szükséges rendszeres ápolási, beállítási, gondozási feladatokat, azok időbeni ütemezését, továbbá a termék teljesítményére, energiafogyasztására, egyéb üzemi jellemzőire vonatkozó műszaki adatokat tartalmaz. Ezek a dokumentációk alapvetően önállóan is megállják a helyüket – mint például a karbantartási útmutató vagy a műszaki adatlap –, de általában egyetlen kézikönyvbe foglalva kerülnek átadásra a berendezés megvásárlásakor, más típusú dokumentációkkal együtt (pl. garancialevél).

A műszaki dokumentáció készítésével a 3. fejezetben foglalkozunk részletesen.